IMotion.EnableAxisUnitConversion method

Enables the axis to use a real-world unit. Changing the unit affects the position and velocity. You need to update MinimumFollowingError, MaximumFollowingError in McProfileSettings and MinimumOutput, MaximumOutput in McPidSettings.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

KsError EnableAxisUnitConversion(
       int Index,
       bool Active
)

Function EnableAxisUnitConversion(
       Index As Integer,
       Active As Boolean
) As KsError

Parameters

Index

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Active

Type: bool

true: Use a real-world unit. false: Use the count unit.

Return value

Type: KsError

A return code of a method.

Examples

N/A